
<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta charset="utf-8" />
    <title>dbm.FluidParticle.return_all &#8212; Texas A&amp;M Oil spill / Outfall Calculator 2.1.0 documentation</title>
    <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
    <script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
    <script src="../../_static/jquery.js"></script>
    <script src="../../_static/underscore.js"></script>
    <script src="../../_static/doctools.js"></script>
    <script src="../../_static/language_data.js"></script>
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="dbm.FluidParticle.slip_velocity" href="dbm.FluidParticle.slip_velocity.html" />
    <link rel="prev" title="dbm.FluidParticle.particle_shape" href="dbm.FluidParticle.particle_shape.html" />
   
  <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
  
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  </head><body>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            
  <div class="section" id="dbm-fluidparticle-return-all">
<h1>dbm.FluidParticle.return_all<a class="headerlink" href="#dbm-fluidparticle-return-all" title="Permalink to this headline">¶</a></h1>
<dl class="method">
<dt id="dbm.FluidParticle.return_all">
<code class="sig-prename descclassname">FluidParticle.</code><code class="sig-name descname">return_all</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">m</em>, <em class="sig-param">T</em>, <em class="sig-param">P</em>, <em class="sig-param">Sa</em>, <em class="sig-param">Ta</em>, <em class="sig-param">status=-1</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/dbm.html#FluidParticle.return_all"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#dbm.FluidParticle.return_all" title="Permalink to this definition">¶</a></dt>
<dd><p>Compute all of the dynamic properties of the bubble in an efficient
manner (e.g., minimizing replicate calls to functions).</p>
<p>This method repeats the calculations in the individual property 
methods, and does not call the methods already defined.  This is done
so that multiple calls to functions (e.g., slip velocity) do not 
occur.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>m</strong><span class="classifier">ndarray, size (nc)</span></dt><dd><p>masses of each component in a particle (kg)</p>
</dd>
<dt><strong>T</strong><span class="classifier">float</span></dt><dd><p>particle temperature (K)</p>
</dd>
<dt><strong>P</strong><span class="classifier">float</span></dt><dd><p>particle pressure (Pa)</p>
</dd>
<dt><strong>Sa</strong><span class="classifier">float</span></dt><dd><p>salinity of ambient seawater (psu)</p>
</dd>
<dt><strong>Ta</strong><span class="classifier">float</span></dt><dd><p>temperature of ambient seawater (K)</p>
</dd>
<dt><strong>status</strong><span class="classifier">int</span></dt><dd><p>flag indicating whether the particle is clean (status = 1) or
dirty (status = -1).  Default value is -1.</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl class="simple">
<dt>A tuple containing:</dt><dd><dl class="simple">
<dt>shape<span class="classifier">integer</span></dt><dd><p>1 - sphere, 2 - ellipsoid, 3 - spherical cap</p>
</dd>
<dt>de<span class="classifier">float</span></dt><dd><p>equivalent spherical diameter (m)</p>
</dd>
<dt>rho_p<span class="classifier">float</span></dt><dd><p>particle density (kg/m^3)</p>
</dd>
<dt>us<span class="classifier">float</span></dt><dd><p>slip velocity (m/s)</p>
</dd>
<dt>A<span class="classifier">float </span></dt><dd><p>surface area (m^2)</p>
</dd>
<dt>Cs<span class="classifier">ndarray, size (nc)</span></dt><dd><p>solubility (kg/m^3)</p>
</dd>
<dt>beta<span class="classifier">ndarray, size (nc)</span></dt><dd><p>mass transfer coefficient (m/s)</p>
</dd>
<dt>beta_T<span class="classifier">float</span></dt><dd><p>heat transfer coefficient (m/s)</p>
</dd>
</dl>
</dd>
</dl>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>Uses the Fortran subroutines in <code class="docutils literal notranslate"><span class="pre">./src/dbm_eos.f95</span></code>.  This method
checks for hydrate stability and returns a reduced mass transfer 
coefficient when hydrate shells are predicted to be present.</p>
</dd></dl>

</div>


          </div>
          
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../../index.html">Texas A&M Oil spill / Outfall Calculator</a></h1>








<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../../user_manual.html">TAMOC User Manual</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../unit_tests.html">Unit Tests</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../bugs.html">Reporting Bugs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../readme.html">Read Me File</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../release.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../license.html">License</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="../../index.html">Documentation overview</a><ul>
  <li><a href="../../user_manual.html">TAMOC User Manual</a><ul>
  <li><a href="../../modules/dbm.html">Overview of the Discrete Bubble Model</a><ul>
  <li><a href="dbm.FluidParticle.html">dbm.FluidParticle</a><ul>
      <li>Previous: <a href="dbm.FluidParticle.particle_shape.html" title="previous chapter">dbm.FluidParticle.particle_shape</a></li>
      <li>Next: <a href="dbm.FluidParticle.slip_velocity.html" title="next chapter">dbm.FluidParticle.slip_velocity</a></li>
  </ul></li>
  </ul></li>
  </ul></li>
  </ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>








        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="footer">
      &copy;2020, Scott A. Socolofsky.
      
      |
      Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
      
      |
      <a href="../../_sources/autodoc/dbm/dbm.FluidParticle.return_all.rst.txt"
          rel="nofollow">Page source</a>
    </div>

    

    
  </body>
</html>